Skip to content

Redo the Pull Request Walk-through docs#7854

Open
mdellweg wants to merge 2 commits into
pulp:mainfrom
mdellweg:doc_cherry_pick
Open

Redo the Pull Request Walk-through docs#7854
mdellweg wants to merge 2 commits into
pulp:mainfrom
mdellweg:doc_cherry_pick

Conversation

@mdellweg

Copy link
Copy Markdown
Member

Adjust to Markdown layout and clarify details around patchback.

📜 Checklist

  • Commits are cleanly separated with meaningful messages (simple features and bug fixes should be squashed to one commit)
  • A changelog entry or entries has been added for any significant changes
  • Follows the Pulp policy on AI Usage
  • (For new features) - User documentation and test coverage has been added

See: Pull Request Walkthrough

@mdellweg mdellweg marked this pull request as ready for review July 13, 2026 13:13

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the extra clarifications on the cherry-pick section.
Is there a particular reason you are using so many exclamations marks?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just grammar. But apparently the use of an exclamation mark to remark an imperative isn't necessarily english...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The one left now is i think warranted for.

Adjust to Markdown layout and clarify details around patchback.
Comment thread docs/dev/guides/pull-request-walkthrough.md Outdated

If you are fixing a bug that should also be backported to another branch than `main`, add the backport label, .e.g `backport-3.18`. PR authors can also add or remove this label if they have write access.
Usually, a bugfix for a bug found in a released version of Pulp should be backported.
If backporting to a specific branch, all supported branches inbetween must receive the backport too.

@dralley dralley Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we say this we should also say where to find the list of supported branches. But realistically an external contributor isn't going to be the one deciding what to backport and where.

Also "inbetween" -> "in between"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. So "Usually," is more like "It is not uncommon that".
What I really wanted to stress is, that you never need to know, because the existing backport labels tell you all about the branches.
That's then why you should never add missing backport labels manually.

Co-authored-by: Daniel Alley <dalley@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants